home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / door / path105.zip / COMMANDS.BOI next >
Text File  |  1993-01-10  |  12KB  |  274 lines
  1. This document is effective 1/10/93
  2. COMMANDS - BOI 2.01
  3.  
  4.     BBS Onliner Interface
  5.     Copyright (C) 1990,1992 Andrew J. Mead
  6.     All Rights Reserved.
  7.  
  8. Introduction
  9.  
  10.     This documentation is a User's Reference Manual for the BBS Onliner
  11.     Interface.  It details available command line parameters and SysOp
  12.     control function keys.  Important Note: All features discussed may
  13.     not be available any given door, and any given door may have
  14.     additional features that are not covered here.  Please refer to any
  15.     door specific documentation as well.
  16.  
  17.       Sections
  18.  
  19.       Command Line Parameters Reference
  20.         BBS Drop File Commands
  21.         Communications Directives
  22.           Local Play
  23.           FOSSIL Communications
  24.           Internal Asynchronious Communications
  25.           Additional Communication Directives
  26.         Configuration Directives
  27.  
  28.       SysOp Function Keys
  29.  
  30.  
  31. BBS Onliner Interface - Command Line Parameters Reference
  32.  
  33.     Notice - This is a listing of all parameters available in the BBS
  34.         Onliner Interface. Not all of these commands may be available
  35.         or have any meaning for the door you are installing.  Also
  36.         note that on the commands that take additional parameters, that
  37.         the initial colon (:) is usually optional, and is only used for
  38.         clarity.
  39.  
  40.     BBS Drop File Commands
  41.         The BOI automatically reads many common drop files, as well as
  42.         being able to accept command line parameters directly from the
  43.         BBS.  Please check the list below for a dropfile created by
  44.         your BBS software.  See INSTALL.BOI for specific information
  45.         and examples.
  46.  
  47.         This list is far from comprehensive, and I encourage any and all
  48.         of you to send me samples of your installation, or information
  49.         about what drop file(s) your BBS can create.
  50.  
  51.         command   dropfile      BBS software - Notes
  52.          /1       PCBOARD.SYS   PCBoard 12.x (see /P)
  53.          /2       JUMBER.DAT    2 A.M.
  54.          /3                     OPUS 1.13 (not available)
  55.          /4       CHAIN.TXT     WWIV, VBBS, TAG, Telegard
  56.          /5       CURRUSER.BBS  RyBBS
  57.          /6       SFDOORS.DAT   Spitfire BBS
  58.          /7       AUNTIE.SYS    Auntie BBS (same format as /1)
  59.          /8                     Sapphire BBS (not available)
  60.          /9       command line  Searchlight, Remote Access, Simplex
  61.          /0       GTUSER.BBS    GT Power
  62.          /D       DOOR.SYS      DoorWay to Unlimited Doors, GT
  63.                                 NOTE:This is the "Short" Door.Sys see /S
  64.          /F       USERINFO.TXT  Forum
  65.          /G       CALLINFO.BBS  Genesis (beta)
  66.          /H       INFO.TXT      Phoenix
  67.          /M       NUMBER.TXT    ModuleX
  68.          /O       LASTUSER.DAT  Opus 1.14
  69.          /Oxx     LASTUSxx.DAT  Opus 1.14 where "xx" is the task number
  70.                                 in hexadecimal
  71.          /P       PCBOARD.SYS   PCBoard 14.x (see /1)
  72.          /S       DOOR.SYS      GAP, Force
  73.                                 NOTE: This is the "Long" Door.Sys see /D
  74.          /W       CALLINFO.BBS  WildCat!, Telegard
  75.  
  76.          /R       DOORINFO.DEF  DorInfo is the most widely used file.
  77.          /R#      DORINFO#.DEF  EIS-PC, FoReM, OLEcom, QuickBBS, RBBS,
  78.                                 Remote Access, TAG, TPBoard, UBBS, and
  79.                                 VBBS. the "#" represents the node number
  80.  
  81.         If this command is missing, the door will default to local mode.
  82.  
  83.         Drop File Path
  84.             If (as recommended) you do not run your online doors from
  85.             your BBS directory, you need to tell the BOI where to find
  86.             the drop file.  You can either copy the file, or add the
  87.             drop file's path to the command line.  Here's an example
  88.             with WildCat! assuming the BBS is in c:\wcat.
  89.  
  90.           doorgame /w:c:\wcat\
  91.  
  92.             Note: the "\" on the end of the path is required, and that
  93.             the first ":" (w:c) is optional (for clarity).
  94.  
  95.         The BOI reads user name, user time remaining, user comm port,
  96.         and (where available) user handle, user screen size, and if the
  97.         user is on the local console.
  98.  
  99.  
  100.     Communications Directives
  101.         Left to its own, the interface will normally detect local play
  102.         from the drop file.  The override switches (/C, /I, /L) should
  103.         only be used with great care.
  104.  
  105.         LOCAL play
  106.             The BOI will normally sense local play, but you can force it
  107.  
  108.             command   effect
  109.              /L       Force LOCAL mode.  Can NOT be overridden.  If
  110.                       either /c or /i is present the door will exit.
  111.  
  112.         FOSSIL Communications
  113.             FOSSIL communications are automatically sensed and used if
  114.             present.  You can, however, influence, their use.  You
  115.             should also note that there are NO slashes (/) before these
  116.             FOSSIL commands.
  117.  
  118.             command   effect
  119.              F-       Do NOT use FOSSIL (/i command gives same result)
  120.  
  121.              F+       Force FOSSIL use. (ignored if /i command present)
  122.                       If FOSSIL not found, door will exit.
  123.  
  124.              F@       Deinitialize FOSSIL when through.  By default, the
  125.                       BOI keeps the FOSSIL "hot".  This can be combined
  126.                       with the above option (F+@).
  127.  
  128.              /C:n     comport to use (see /C:n below).
  129.  
  130.         Internal Asynchronious Communincations
  131.             The BOI contains its own fully functional communciations
  132.             library that is very configurable.  If FOSSIL is either
  133.             disabled or not found, these routines will be used.
  134.  
  135.             command   effect
  136.              /B       Locked BAUD (DTE-DCE) rate.  If you are running
  137.                       your modem with a "locked" baud rate, you will
  138.                       NEED to add this command to your command line.
  139.                       The internal routines use RTS handshaking by
  140.                       default.  This switch tells them to use CTS/RTS
  141.                       handshaking which prevents modem overrun.
  142.  
  143.              /C:n     Serial port to use.  You can force the program to
  144.                       use a given serial port.  Valid values are from
  145.                       1 to 8.  (NOTE: 5 to 8 are only defined if the
  146.                       FOSSIL is also used).  This command is necessary
  147.                       if the drop file is wrong, or you are using
  148.                       command line directives only.  If /l or /i is
  149.                       present the door will exit.
  150.  
  151.             /I:x:nnnn Non-standard IRQ specification.  If you are not
  152.                       using FOSSIL, and you do have a non-standard
  153.                       serial port configuartion, you can use this
  154.                       option to specify your IRQ/port address info.
  155.                       The default settings, would be equivalent to
  156.                           Com1 : /i:4:03f8
  157.                           Com2 : /i:3:02f8
  158.                           Com3 : /i:4:03e8
  159.                           Com4 : /i:3:02e8
  160.                       The 'x' is the IRQ number.  It is a hexidecimal
  161.                       value from 0 to f.  'nnnn' is the port address for
  162.                       communications.  It is a 4 digit hexidecimal value
  163.                       If this command is present, the FOSSIL routines
  164.                       will not be used.  If /c or /l is present the door
  165.                       will exit.
  166.  
  167.         Additional Communications Directives
  168.             command   effect
  169.              /K       Do NOT check for Carrier detect.  This should only
  170.                       be used in dire cases.  If this switch is used,
  171.                       the door may not time out if the remote user hangs
  172.                       up the phone.
  173.  
  174.                       If your modem does not properly maintain a Carrier
  175.                       Detect signal, the game will automatically abort.
  176.                       This option supresses this activity. If you are
  177.                       forced to use this option, you probably are having
  178.                       hardware problems with the modem, RS-232 connector
  179.                       (bad pin or broken wire), or modem cable.
  180.  
  181.  
  182.     Configuration Directives
  183.         command  effect
  184.          /A      Play Again? (default x=10)
  185.          /A:x    If this mode is present, it is available with the door
  186.                  you are using, and the user has more than x minutes
  187.                  remaining, they will be asked if they wish to play
  188.                  again.
  189.  
  190.          /N:...  User Name (ie: /n:Doc_Technical)
  191.                  This option allows you to pass the door the user's name
  192.                  through the command line.  This is handy for BBSes like
  193.                  Searchlight, or if you are playing locally from DOS.
  194.                  Underscores are converted to spaces.
  195.  
  196.          /Q      Quiet Local Mode
  197.                  This will prevent all ^G bells from ringing the local
  198.                  console.  (Unless the door author specifically
  199.                  overrides it).  This option will help SysOps get full
  200.                  nights worth of sleep.
  201.  
  202.          /Z:x    User Time Limit
  203.                  x is an amount of time between 10 and 50.  The user's
  204.                  time allowed will be the lesser of this value, and the
  205.                  amount found in the BBS drop file.
  206.  
  207.          /X:n    Limit Hall of Fame listings
  208.                  You can limit the time any one name appears in the
  209.                  monthly top 20 with this switch.  The default is no
  210.                  limitation.  The recommended limit is 1 or 2.  This
  211.                  keeps a small number of players from monopolizing the
  212.                  game.  If an occassional (non-fanatical) is more likely
  213.                  to see his name listed, he is more likely to play the
  214.                  game.  n is any number from 1 to 19.
  215.  
  216.          /Y      Alternate path/filespec for text Hall of Fame
  217.                  /y:<pathspec>\   (ie: /y:c:\wcat\bulls\)
  218.                      In the sample above, the text Hall of Fame (if
  219.                      applicable) will be placed into c:\wcat\bulls
  220.                      using the default name (found in the games docs).
  221.                  /y:<filespec>    (ie: /y:c:\wcat\bulls\bull4.bbs)
  222.                      In the sample above, the text Hall of Fame will be
  223.                      placed in c:\wcat\bulls, and it will be named
  224.                      bull4.bbs.
  225.  
  226.          A+      Enable AVATAR/1.  NOTE: The AVATAR codes are
  227.                  relatively untested.  If you use this switch, please
  228.                  let me know whether it works or doesn't.
  229.  
  230.  
  231. BBS Onliner Interface - SysOp Function Keys
  232.     The SysOp is afforded the following SysOp functions.
  233.  
  234.     keypress  action
  235.      F2       Toggle User Status Line.  This will toggle between the
  236.               following current modes:
  237.                   Display Time Remaining (default)
  238.                   Display Active Communications (FOSSIL or internal)
  239.                   Display Remote graphics (ASCII, ANSI, AVATAR/1)
  240.  
  241.      F7       Decrement (reduce) user's time remaining by 1 minute.
  242.      F8       Increment (increase) user's time remaining by 1 minute.
  243.  
  244.      F9       Drop Carrier.  (Fake line noise).  This will disconnect
  245.               the current communications and send the user a string of
  246.               random characters to simulate line noise.
  247.  
  248.      F10      Force return to BBS.  This sends the user a notice
  249.               informing them that the SysOp has terminated the session.
  250.               It then returns control to the BBS.  (Ctrl-Break) will
  251.               also exit the game, but not as pleasently.
  252.  
  253.  
  254. BBS Onliner Interface
  255. Copyright (C) 1990, 1992 Andrew J. Mead
  256. All Rights Reserved.
  257.  
  258. Contact:
  259.     Andrew J. Mead
  260.     PO BOX 1155
  261.     Chapel Hill, NC 27514-1155
  262.     USA
  263.  
  264.     1@9952 WWIVnet
  265.     1@9395 VirtualNet
  266.     1:3641/417 FidoNet
  267.     75:7919/417 DoorNet
  268.  
  269.     +919 489 9446 - PCP:NCRTP - V32BIS - 24HRS
  270.  
  271. This interface is currently written in Turbo Pascal 5.5, 6.0 and
  272. can be licensed by other programmers.  Contact me for details.
  273.  
  274. END COMMANDS.BOI